Skip to content

Adds a new example: onReceiveExample.ino #9415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Mar 26, 2024
Merged

Adds a new example: onReceiveExample.ino #9415

merged 7 commits into from
Mar 26, 2024

Conversation

SuGlider
Copy link
Collaborator

Adds a new example that uses HardwareSerial::onReceive(). The example demosntrates how to read all the data sent to UART0, considering that the end of transmission is defined by a period of time with UART in idle state.

Description of Change

This PR adds a new example that uses HardwareSerial::onReceive().
The example demosntrates how to read all the data sent to UART0, considering that the end of transmission is defined by a period of time with UART in idle state.

This is based on a question from a user.

Tests scenarios

Tested using the code from the example with the ESP32, ESP32-S3 and ESP32-C3.

Related links

#6102 (comment)

@SuGlider
feat: onReceiveExample.ino
9d787c2 
Adds a new example that uses HardwareSerial::onReceive(). The example demosntrates how to read all the data sent to UART0, considering that the end of transmission is defined by a period of time with UART in idle state.
@SuGlider SuGlider added this to the 3.0.0-RC1 milestone Mar 25, 2024
@SuGlider SuGlider self-assigned this Mar 25, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 25, 2024 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat: Mutex NULL testing":
    • summary looks too short
  • the commit message "feat: Mutex error message":
    • summary looks too short
  • the commit message "feat: onReceiveExample.ino":
    • body's lines must not be longer than 100 characters
  • the commit message "fix: mutex release":
    • summary looks too short

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
⚠️ Please consider squashing your 7 commits (simplifying branch history).
⚠️

The source branch "SuGlider-patch-2" incorrect format:

  • contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS).
    Please rename your branch.

👋 Hello SuGlider, we appreciate your contribution to this project!

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 3fecfce

@VojtechBartoska VojtechBartoska added the Type: Example Issue is related to specific example. label Mar 25, 2024
P-R-O-C-H-Y
P-R-O-C-H-Y approved these changes Mar 25, 2024
View reviewed changes
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Tested on ESP32-S2 👍

lucasssvaz
lucasssvaz reviewed Mar 25, 2024
View reviewed changes
Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just a small suggestion.

@SuGlider SuGlider requested a review from lucasssvaz March 25, 2024 23:45
@SuGlider
Copy link
Collaborator Author

@lucasssvaz @me-no-dev - it shall be ready now.

@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Mar 26, 2024
@me-no-dev me-no-dev merged commit 6345350 into master Mar 26, 2024
46 checks passed
@me-no-dev me-no-dev deleted the SuGlider-patch-2 branch March 26, 2024 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

@me-no-dev me-no-dev Awaiting requested review from me-no-dev

Assignees

@SuGlider SuGlider

Labels
Peripheral: UART Status: Pending Merge Pull Request is ready to be merged Type: Example Issue is related to specific example.
Projects
Arduino ESP32 Core Project Roadmap
Status: Done
Milestone
3.0.0-RC1
Development

Successfully merging this pull request may close these issues.
5 participants
@SuGlider @me-no-dev @lucasssvaz @P-R-O-C-H-Y @VojtechBartoska